Skip to content

docs: reconcile audited design and implementation drift - #2629

Merged
codeforester merged 3 commits into
mainfrom
documentation/2628-20261021-reconcile-audited-documentation-drift
Nov 5, 2026
Merged

codeforester merged 3 commits into
mainfrom
documentation/2628-20261021-reconcile-audited-documentation-drift

Conversation

@codeforester

@codeforester codeforester commented Oct 21, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Several maintained guides describe older behavior even though the corresponding runtime changes are implemented and tested. Reconcile the audited contracts across design, user/reference docs, contributor guidance, and AI context without changing runtime code.

  • Include test.requirements in the project-runtime decision table and make IDE mutation consent explicit.
  • Specify the accepted earlier-BOM/tag release recovery path from fix: recover a tagged release after publication tooling changes #2551, and document uninstall's confirmed retention contract: project run bundles are removed, Base-level history remains.
  • Document workspace deadlines/cancellation, current review policy, and all 18 Python package responsibilities.
  • Repair the registry and technical-overview examples, including the overview's required release repository field; distinguish static package inspection from explicit runtime verification.
  • Add the missing unreleased activation-repair note. Upgrade guidance and its notes are handled separately under docs: document the Base upgrade contract across Homebrew and source installs #2597.

Issue

Fixes #2628

Refs #1611 and #1613 for broader runtime separation and the future input schema; neither is implemented or closed by this PR.

Validation

  • 209 pytest cases and 38 subtests passed across the existing documentation checks, contract hardening, command-reference flags, version docs, and focused routing, IDE consent, uninstall, release/readiness/publication, and workspace setup/test/process tests.
  • After the final AI command-context correction, reran command-reference flags, contract hardening, and repository documentation links: 16 passed. After adding the registry evidence map, reran contract hardening and documentation links: 15 passed.
  • Extracted both corrected YAML blocks and passed them to the production manifest/registry parsers. Disposable probes reconfirmed requirements-triggered routing, static unverified readiness, and the documented uninstall retention split.
  • Checked all 11 local heading links in changed documents and matched the ownership table against all 18 tracked Python packages.
  • git diff --check passed. No real install, release publication, or uninstall was performed.

Design Impact

Reconciles descriptions of implemented behavior. Release recovery follows the accepted #2551 contract. Uninstall explicitly retains the existing removal/retention behavior and describes its verification limits. No new runtime behavior or documentation-governance gate is introduced.

Docs Impact

Canonical runtime, IDE, release, workspace, ownership, and review documents now agree with the implementation. A dedicated uninstall guide is linked from the index, command reference, stability contract, cache layout, and adopter guide. Contributor guidance distinguishes Base-owned Python packages from the external framework and the legacy CI search-path entry. The contract registry maps reconciled behavior to implementation/tests and states the remaining semantic-coverage limits.

AI Context Impact

Update ARCHITECTURE, COMMANDS, and STATUS for runtime triggers, isolated wrapper execution, and static versus explicitly executing requirements inspection.

Release Notes

Unreleased now records the activation discovery repair from #2611. Documentation corrections do not change published release contents. The two missing upgrade notes belong to #2597's PR.

Demo Impact

None. This PR changes documentation only and preserves existing runtime/demo behavior.

Review follow-up

  • Corrected the repository-policy YAML example to use the parser-required review_policy mapping and clarified that the manifest example is representative rather than exhaustive.
  • Updated the CI supply-chain guide to show the current Bandit command, including both cli/python and lib/python; the repository currently has no tracked Base package under lib/python.
  • Updated the technical overview's Bandit row to match the current CI scan paths. No CI configuration or runtime behavior changed here.

For this follow-up revision, git diff --check passed. The broader local test results above were collected before these final prose edits; all hosted checks for this head have passed.

@codeforester
codeforester merged commit ecb2f90 into main Nov 5, 2026
25 checks passed
@codeforester
codeforester deleted the documentation/2628-20261021-reconcile-audited-documentation-drift branch November 5, 2026 14:44
codeforester added a commit that referenced this pull request Nov 5, 2026
## Summary

Users lack one reliable upgrade procedure across Homebrew, mutable
source checkouts, and stable source tags. Add a canonical upgrade matrix
and recovery guide, then link installation, shell, FAQ, command, and
agent guidance to it.

The guide distinguishes current-main behavior from v1.10.5: `update
--release` and reconciliation after an unchanged Homebrew version were
added later. It covers older-version fallback, direct
package-manager/Git operations, active-install selection, setup failures
after a ref change, runtime verification, and trust re-review.

## Issue

Fixes #2597

Related audit corrections are in #2629 / #2628. This PR can be reviewed
independently; both are documentation-only and target main.

## Validation

- Existing documentation, local-link, contract-hardening,
command-reference, and version checks: 80 pytest cases passed.
- `bats cli/bash/commands/basectl/tests/update.bats`: all 28 cases
passed, covering stable-tag upgrade/refusal/recovery, Homebrew
reconciliation including unchanged versions, and mutable/project update
behavior.
- All 50 local heading links across changed documents resolved. After
linking the upgrade contract into the registry, reran contract hardening
and documentation links: 15 passed.
- Compared the matrix and failure procedures against `update.sh`; `git
diff --check` passed.
- No real Homebrew upgrade, source upgrade, setup, or trust mutation was
performed.

## Design Impact

Documents the implemented update routes and their boundaries. No runtime
changes, automatic trust approval, downgrade capability, or new
release-verification guarantee is introduced. Remote tag matching is
explicitly distinguished from immutable release/BOM evidence.

## Docs Impact

`docs/upgrading.md` is the canonical upgrade procedure. README, FAQ,
documentation index, bootstrap recipes, shell-startup guidance, Homebrew
rehearsal, command reference, and `skills.md` now point to it. Duplicate
upgrade procedures were consolidated to reduce synchronization risk. The
contract registry links the guide to existing update behavior tests
while preserving the need for prose review.

## AI Context Impact

Add the route-specific update summary and canonical guide reference to
`.ai-context/COMMANDS.md`.

## Release Notes

Add the missing Unreleased notes for stable-source `--release` support
and unconditional Homebrew runtime reconciliation. Published release
sections remain unchanged.

## Demo Impact

None. Existing command and demo behavior is unchanged; upgrade
verification and the distinction between Base and consumer-project tests
are documented.


## Review follow-up

- The README's Homebrew upgrade link now points to the canonical upgrade
guide; the install recipe remains the new-install entry point.
- Updated the AI command context and its help-output assertion for the
stable-source `--release <tag>` behavior.
- Added `--release <tag>` and the guide link to the `basectl update` row
in the technical overview.

For this follow-up revision, `git diff --check` passed. The broader
local test results above were collected before these final edits; hosted
checks for the current head are running.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation improvements

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: reconcile audited design and implementation drift

1 participant